<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
<!-- qevent.cpp -->
  <title>QHelpEvent Class | Qt GUI 5.14.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td ><a href="../qtdoc/index.html">Qt 5.14</a></td><td ><a href="qtgui-index.html">Qt GUI</a></td><td ><a href="qtgui-module.html">C++ Classes</a></td><td >QHelpEvent</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtgui-index.html">Qt 5.14.2 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QHelpEvent Class</h1>
<!-- $$$QHelpEvent-brief -->
<p>The QHelpEvent class provides an event that is used to request helpful information about a particular point in a widget. <a href="#details">More...</a></p>
<!-- @@@QHelpEvent -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QHelpEvent&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += gui</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="../qtcore/qevent.html">QEvent</a></td></tr></table></div><ul>
<li><a href="qhelpevent-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qhelpevent.html#QHelpEvent">QHelpEvent</a></b>(QEvent::Type <i>type</i>, const QPoint &amp;<i>pos</i>, const QPoint &amp;<i>globalPos</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QPoint &amp;</td><td class="memItemRight bottomAlign"><b><a href="qhelpevent.html#globalPos">globalPos</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qhelpevent.html#globalX">globalX</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qhelpevent.html#globalY">globalY</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QPoint &amp;</td><td class="memItemRight bottomAlign"><b><a href="qhelpevent.html#pos">pos</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qhelpevent.html#x">x</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qhelpevent.html#y">y</a></b>() const</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QHelpEvent-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>This event can be intercepted in applications to provide tooltips or &quot;What's This?&quot; help for custom widgets. The <a href="../qtcore/qevent.html#type">type</a>() can be either <a href="../qtcore/qevent.html#Type-enum">QEvent::ToolTip</a> or <a href="../qtcore/qevent.html#Type-enum">QEvent::WhatsThis</a>.</p>
</div>
<p><b>See also </b><a href="../qtwidgets/qtooltip.html">QToolTip</a>, <a href="../qtwidgets/qwhatsthis.html">QWhatsThis</a>, <a href="qstatustipevent.html">QStatusTipEvent</a>, and <a href="qwhatsthisclickedevent.html">QWhatsThisClickedEvent</a>.</p>
<!-- @@@QHelpEvent -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QHelpEvent[overload1]$$$QHelpEventQEvent::TypeconstQPoint&constQPoint& -->
<h3 class="fn" id="QHelpEvent"><a name="QHelpEvent"></a>QHelpEvent::<span class="name">QHelpEvent</span>(<span class="type"><a href="../qtcore/qevent.html#Type-enum">QEvent::Type</a></span> <i>type</i>, const <span class="type"><a href="../qtcore/qpoint.html">QPoint</a></span> &amp;<i>pos</i>, const <span class="type"><a href="../qtcore/qpoint.html">QPoint</a></span> &amp;<i>globalPos</i>)</h3>
<p>Constructs a help event with the given <i>type</i> corresponding to the widget-relative position specified by <i>pos</i> and the global position specified by <i>globalPos</i>.</p>
<p><i>type</i> must be either <a href="../qtcore/qevent.html#Type-enum">QEvent::ToolTip</a> or <a href="../qtcore/qevent.html#Type-enum">QEvent::WhatsThis</a>.</p>
<p><b>See also </b><a href="qhelpevent.html#pos">pos</a>() and <a href="qhelpevent.html#globalPos">globalPos</a>().</p>
<!-- @@@QHelpEvent -->
<!-- $$$globalPos[overload1]$$$globalPos -->
<h3 class="fn" id="globalPos"><a name="globalPos"></a>const <span class="type"><a href="../qtcore/qpoint.html">QPoint</a></span> &amp;QHelpEvent::<span class="name">globalPos</span>() const</h3>
<p>Returns the mouse cursor position when the event was generated in global coordinates.</p>
<p><b>See also </b><a href="qhelpevent.html#pos">pos</a>(), <a href="qhelpevent.html#globalX">globalX</a>(), and <a href="qhelpevent.html#globalY">globalY</a>().</p>
<!-- @@@globalPos -->
<!-- $$$globalX[overload1]$$$globalX -->
<h3 class="fn" id="globalX"><a name="globalX"></a><span class="type">int</span> QHelpEvent::<span class="name">globalX</span>() const</h3>
<p>Same as <a href="qhelpevent.html#globalPos">globalPos</a>().<a href="qhelpevent.html#x">x</a>().</p>
<p><b>See also </b><a href="qhelpevent.html#x">x</a>(), <a href="qhelpevent.html#globalY">globalY</a>(), and <a href="qhelpevent.html#globalPos">globalPos</a>().</p>
<!-- @@@globalX -->
<!-- $$$globalY[overload1]$$$globalY -->
<h3 class="fn" id="globalY"><a name="globalY"></a><span class="type">int</span> QHelpEvent::<span class="name">globalY</span>() const</h3>
<p>Same as <a href="qhelpevent.html#globalPos">globalPos</a>().<a href="qhelpevent.html#y">y</a>().</p>
<p><b>See also </b><a href="qhelpevent.html#y">y</a>(), <a href="qhelpevent.html#globalX">globalX</a>(), and <a href="qhelpevent.html#globalPos">globalPos</a>().</p>
<!-- @@@globalY -->
<!-- $$$pos[overload1]$$$pos -->
<h3 class="fn" id="pos"><a name="pos"></a>const <span class="type"><a href="../qtcore/qpoint.html">QPoint</a></span> &amp;QHelpEvent::<span class="name">pos</span>() const</h3>
<p>Returns the mouse cursor position when the event was generated, relative to the widget to which the event is dispatched.</p>
<p><b>See also </b><a href="qhelpevent.html#globalPos">globalPos</a>(), <a href="qhelpevent.html#x">x</a>(), and <a href="qhelpevent.html#y">y</a>().</p>
<!-- @@@pos -->
<!-- $$$x[overload1]$$$x -->
<h3 class="fn" id="x"><a name="x"></a><span class="type">int</span> QHelpEvent::<span class="name">x</span>() const</h3>
<p>Same as <a href="qhelpevent.html#pos">pos</a>().x().</p>
<p><b>See also </b><a href="qhelpevent.html#y">y</a>(), <a href="qhelpevent.html#pos">pos</a>(), and <a href="qhelpevent.html#globalPos">globalPos</a>().</p>
<!-- @@@x -->
<!-- $$$y[overload1]$$$y -->
<h3 class="fn" id="y"><a name="y"></a><span class="type">int</span> QHelpEvent::<span class="name">y</span>() const</h3>
<p>Same as <a href="qhelpevent.html#pos">pos</a>().y().</p>
<p><b>See also </b><a href="qhelpevent.html#x">x</a>(), <a href="qhelpevent.html#pos">pos</a>(), and <a href="qhelpevent.html#globalPos">globalPos</a>().</p>
<!-- @@@y -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2020 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>
